Resource URL: /platform/<<version=2>>/protocols/nfs/aliases/<AID>

    Overview: This resource applies the standard collection pattern to
              individual NFS exports.  AID in the resource path is the alias ID.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve export information.

       URL: GET /platform/<<version=2>>/protocols/nfs/aliases/<AID>

Query arguments:
 scope=<enum> Where <enum> is one of effective, user.  When specified as
              'effective', or not specified, all fields are returned. When
              specified as 'user', only fields with non-default values are
              shown. When specified as 'default', the original values are
              returned.
zone=<string> Access zone

GET response body schema:
{
  "type": "object", 
  "properties": {
    "aliases": {
      "items": {
        "type": "object", 
        "description": "Specifies properties for NFS aliases, which are names for physical paths in the file system.", 
        "properties": {
          "path": {
            "type": "string", 
            "description": "Specifies the path to which the alias points."
          }, 
          "health": {
            "type": [
              {
                "enum": [
                  "good", 
                  "illegal file type", 
                  "illegal path", 
                  "name conflict", 
                  "not exported", 
                  "path not found", 
                  "unknown"
                ], 
                "type": "string", 
                "description": "Specifies whether the alias is usable."
              }
            ], 
            "description": "Specifies whether the alias is usable."
          }, 
          "id": {
            "type": "string", 
            "description": "Specifies a string which represents the unique location of the alias."
          }, 
          "zone": {
            "type": "string", 
            "description": "Specifies the zone in which the alias is valid."
          }, 
          "name": {
            "type": "string", 
            "description": "Specifies the name by which the alias can be referenced."
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method PUT: Modify the alias. All input fields are optional, but one or more
            must be supplied.

       URL: PUT /platform/<<version=2>>/protocols/nfs/aliases/<AID>

Query arguments:
zone=<string> Access zone

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies properties for NFS aliases, which are names for physical paths in the file system.", 
  "properties": {
    "path": {
      "type": "string", 
      "description": "Specifies the path to which the alias points."
    }, 
    "health": {
      "type": [
        {
          "enum": [
            "good", 
            "illegal file type", 
            "illegal path", 
            "name conflict", 
            "not exported", 
            "path not found", 
            "unknown"
          ], 
          "type": "string", 
          "description": "Specifies whether the alias is usable."
        }
      ], 
      "description": "Specifies whether the alias is usable."
    }, 
    "name": {
      "type": "string", 
      "description": "Specifies the name by which the alias can be referenced."
    }, 
    "zone": {
      "type": "string", 
      "description": "Specifies the zone in which the alias is valid."
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete the export.

          URL: DELETE /platform/<<version=2>>/protocols/nfs/aliases/<AID>

Query arguments:
zone=<string> Access zone

There is no response body for this method.
